home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / TimeKpDev9503.lha / TimeKeep-Dev / Doc.txt / TimeKeep-Dev.txt < prev   
Encoding:
Text File  |  1995-03-21  |  18.9 KB  |  615 lines
  1. TimeKeep-Dev Documentation
  2. ----------------------------------------------------------------------------
  3.                               TimeKeep-Dev
  4.                                v 95.Mar.21
  5.  
  6.    Description 
  7.  
  8.    Shareware                             Tutorial 
  9.  
  10.    Development and Testing               Gadgets 
  11.  
  12.    Installing                            Project Name Codes 
  13.    Starting   
  14.  
  15.    Configuration 
  16.  
  17.    Error Messages      
  18.    Future Enhancements                   Programming 
  19.    Known BUGS          
  20.  
  21.                                          Legalness  
  22.                                          Thank Yous 
  23.    New in this version 
  24.    Previous versions                                  Locating The Author 
  25.  
  26.  
  27.                   TimeKeep-Dev is a time-clock utility
  28.          for keeping track of time spent on project development.
  29. ============================================================================
  30. Description
  31. ----------------------------------------------------------------------------
  32. Description
  33. -----------
  34.  
  35. TimeKeep-Dev is a time-clock utility for keeping track of time spent on
  36. project development.
  37.  
  38. Projects and Modules can be defined and a time clock interface used to
  39. TimeIn and TimeOut on a selected Module.  TimeKeep-Dev will remember
  40. which Module is currently in progress and will select it automatically
  41. when the program is re-started.
  42. ============================================================================
  43. Shareware
  44. ----------------------------------------------------------------------------
  45. Shareware
  46. ---------
  47.  
  48. A great deal of time has been spent in the development of TimeKeep-Dev.
  49.  
  50. This version is partially SAVE disabled.  If you wish to receive a
  51. non-disabled version of TimeKeep-Dev, a Shareware fee of $15.00 (US) or
  52. more is required.  See:  Locating The Author 
  53.  
  54. Your shareware payment helps to insure continued development of
  55. TimeKeep-Dev. See:  Future Enhancements 
  56. ============================================================================
  57. Development and Testing
  58. ----------------------------------------------------------------------------
  59. Development and Testing
  60. -----------------------
  61.  
  62. TimeKeep-Dev was developed on an Amiga 3000T/25MHz with 2 Meg CHIP / 8
  63. Meg FAST memory.
  64.  
  65. TimeKeep-Dev has been tested under Kickstart version 37.175, Workbench
  66. version 38.12.
  67. ============================================================================
  68. Installing
  69. ----------------------------------------------------------------------------
  70. Installing
  71. ----------
  72.  
  73. The following files should be contained in the same directory:
  74.  
  75.                             TimeKeep-Dev
  76.                             TimeKeep-Dev.info
  77.  
  78.  
  79. Sample Data files
  80. -----------------
  81.  
  82. The files contained in the "sample data" directory have been provided as
  83. examples of the output created by TimeKeep-Dev.  To test them, copy them
  84. into your S: directory and run TimeKeep-Dev.  These data files will also
  85. allow you to see how the registered version remembers the contents of the
  86. SoFar gadget to display the total hours:minutes spent on projects.
  87. ============================================================================
  88. Starting
  89. ----------------------------------------------------------------------------
  90. Starting
  91. --------
  92.  
  93. From Workbench, double-click on the TimeKeep-Dev icon.
  94. ============================================================================
  95. Configuration
  96. ----------------------------------------------------------------------------
  97. Configuration
  98. -------------
  99.  
  100. TimeKeep-Dev supports configuration through use of Workbench ToolTypes.
  101. If any options are not included as a ToolType, the stated defaults will
  102. be used.
  103.  
  104. ToolTypes can be typed in upper or lower case or any combination of the
  105. two.  To have a ToolType ignored surround it with brackets ( ).
  106.  
  107. For example:
  108.                             (ToolType=Value)
  109.  
  110.  
  111. Invalid settings and ToolTypes will be ignored.  In this case, the default
  112. values will be used.
  113.  
  114. The following configuration commands are supported:
  115.  
  116.   AutoProjectNameCode=
  117.     Description: If set to YES, TimeKeep-Dev will automatically create a
  118.                  Project Name Code using its built-in function, when
  119.                  adding a new Project.
  120.  
  121.                  See  Project Name Codes  for more information.
  122.  
  123.     Valid values: YES, NO
  124.  
  125.     Default: YES
  126.  
  127.     Example: AutoProjectNameCode=NO
  128.  
  129.  
  130.   BackFillColor=
  131.     Description: Sets the palette color to use when filling the
  132.                  background.  A value of -1 will disable the fill.
  133.                  Colors are numbered from 0 up.
  134.  
  135.                  For MagicWB users, a value of 4 is recommended.
  136.  
  137.                  TimeKeep-Dev's NewScreen is currently a 4 color screen,
  138.                  taking its palette from the Workbench.
  139.  
  140.     Valid values: -1, 0...(nColors-1)
  141.  
  142.     Default: -1
  143.  
  144.     Example: BackFillColor=4
  145.  
  146.  
  147.   Database=
  148.     Description: This is the FULL PATH and FILENAME of the data file
  149.                  created by TimeKeep-Dev.  This file is where
  150.                  TimeKeep-Dev stores Project and Module information.
  151.  
  152.     Default: "S:TimeKeep-Dev.data"
  153.  
  154.     Example: Database="DATA:ScotwareSoftware/.TimeKeep-Dev.data"
  155.  
  156.  
  157.   DataPath=
  158.     Description: This is the FULL PATH to where TimeKeep-Dev will create
  159.                  its .time files.  These files contain TimeIn and TimeOut
  160.                  information for generating invoices.
  161.  
  162.     Default: "S:TimeKeep-Dev"
  163.  
  164.     Example: DataPath="DATA:ScotwareSoftware/.TimeKeep-Dev"
  165.  
  166.  
  167.   DefaultModule=
  168.  
  169.     Description: This is the text to be used as the name of the default
  170.                  Module.  When a new Project is added, a default Module
  171.                  is automatically created.
  172.  
  173.     Default: "General"
  174.  
  175.     Example: DefaultModule="Miscellaneous"
  176.  
  177.  
  178.   Font=
  179.     Description: This is the name of an 8 point font to be used within
  180.                  TimeKeep-Dev.  Currently, only 8 point Proportional or
  181.                  Non-Proportional fonts are supported.
  182.  
  183.                  TimeKeep-Dev will use the Default System Font,
  184.                  regardless of size, for the window title bar, if opened
  185.                  on the Default Public Screen.  If you use a really large
  186.                  Default System Font, you may have problems with the
  187.                  error message display.  If this is a problem for you,
  188.                  try using the NewScreen option, and the Font option to
  189.                  set a smaller font.
  190.  
  191.     Valid values: Any 8 point, Proportional or Non-Proportional font.
  192.  
  193.     Default: "topaz.font"
  194.  
  195.     Example: Font="Topaz2p"
  196.  
  197.  
  198.   NewScreen=
  199.     Description: If set to YES, TimeKeep-Dev will open on its own Public
  200.                  Screen.
  201.  
  202.                  If set to NO, TimeKeep-Dev will open on the default
  203.                  Public Screen.
  204.  
  205.     Valid values: YES, NO
  206.  
  207.     Default: NO
  208.  
  209.     Example: NewScreen=YES
  210. ============================================================================
  211. Error Messages
  212. ----------------------------------------------------------------------------
  213. Error Messages
  214. --------------
  215.  
  216. Could Not Create Gadgets
  217.  
  218. - TimeKeep-Dev was not able to create its gadgets.
  219.  
  220. Could Not Lock Screen
  221.  
  222. - TimeKeep-Dev could not get a lock on a default public screen, or could
  223.   not get visual information from it.  TimeKeep-Dev may not have been
  224.   able to find Workbench or another public screen to open on.
  225.  
  226. Could Not Open Font
  227.  
  228. - TimeKeep-Dev was not able to locate, or open the requested font as an 8
  229.   point font.
  230.  
  231. Could Not Open Screen
  232.  
  233. - TimeKeep-Dev was not able to open its own screen.
  234.  
  235. Could Not Open Window
  236.  
  237. - TimeKeep-Dev was not able to open its window.
  238.  
  239. Insufficient Memory
  240.  
  241. - TimeKeep-Dev could not allocate memory to create its structures and
  242.   lists.
  243.  
  244.  
  245. ERROR: Project Exists
  246.  
  247. - The Project Name already exists.  There can not be two Projects with the
  248.   same name.
  249.  
  250. ERROR: Default Module can not be edited
  251.  
  252. - The name of the Default Module can not be edited.  It can only be set
  253.   globally using the DefaultModule Tooltype.
  254.  
  255. ERROR: Insufficient Memory
  256.  
  257. - There was not enough memory to perform the requested function.
  258.  
  259. ERROR: Invalid Project Code
  260.  
  261. - The Project Code already exists or has not been confirmed by pressing
  262.   ENTER within the Code gadget.  There can not be two Projects with the
  263.   same Project code.
  264.  
  265. ERROR: Module Exists
  266.  
  267. - The Module Name already exists.  There can not be two Modules with the
  268.   same name.
  269. ============================================================================
  270. Tutorial
  271. ----------------------------------------------------------------------------
  272. Tutorial
  273. --------
  274.  
  275. This tutorial will single-step you through the normal operation of
  276. TimeKeep-Dev.
  277.  
  278. The assumption is made that you have not changed any of the defaults
  279. through use of ToolTypes.
  280.  
  281.  
  282. ADDING A NEW PROJECT
  283. ====================
  284.  
  285. · Start TimeKeep-Dev by Double-Clicking on its icon.
  286.  
  287. When you use TimeKeep-Dev for the very first time, the only gadget that
  288. will be selectable is the ADD gadget, under the Project list requester.
  289. If data had already been entered into TimeKeep-Dev, that data would now
  290. be displayed.
  291.  
  292. · Left-click on the ADD gadget under the Project list requester.
  293.  
  294. The Project Name string gadget is auto-selected.
  295.  
  296. · Type 'Test Number 1' {ENTER}
  297.  
  298. If you wish to abort ADDing, at any time click on the DELETE gadget.
  299.  
  300. The code 'TN1' is automatically entered into the CODE: string gadget and
  301. the gadget is auto-selected.
  302.  
  303. If the auto-created Code is satisfactory, just press {ENTER}.  If you
  304. wish to alter it, you may do so.  If you have set AutoProjectNameCode to
  305. NO, the gadget will be empty, and you must enter a Code.  We will change
  306. the default Code...
  307.  
  308. · Type 'TN1' {ENTER}
  309.  
  310. The gadget should now contain 'TN1TN1'.
  311.  
  312. 'Test Number 1' will now be added to the Project List and the default
  313. Module 'General' will be added to the Module List.
  314.  
  315.  
  316. ADDING A NEW MODULE
  317. ===================
  318.  
  319. · Left-Click on the ADD gadget, under the Module List.
  320.  
  321. The Module Name string gadget is auto-selected.
  322.  
  323. · Type 'Module 2' {ENTER}
  324.  
  325. If you wish to abort ADDing, at any time click on the DELETE gadget.
  326.  
  327. 'Module 2' will now be added to the Module List.
  328.  
  329.  
  330. KEEPING TRACK OF TIME
  331. =====================
  332.  
  333. When you are ready to start/continue work on a Module, all you have to
  334. do is select the Module (or add a new Module) and TimeIn.
  335.  
  336. · Left-Click on the Time In gadget
  337.  
  338. The current time will appear in the Time In string gadget.  If the Date
  339. and Time are satisfactory, you may continue.  If you wish to make changes
  340. you may do so by selecting the Date or Time string gadget and making
  341. changes followed by {ENTER}.
  342.  
  343.  
  344. TIMING-OUT OF A MODULE IN PROGRESS
  345. ==================================
  346.  
  347. When you have already started a Module using Time In, that Module will be
  348. remembered the next time you start TimeKeep-Dev, and will be
  349. automatically selected.
  350.  
  351. If we were Exiting and Re-starting TimeKeep-Dev, the 'Module 2' Module
  352. would be automatically selected since it now has a TimeIn.
  353.  
  354. · Left-Click on the Time Out gadget
  355.  
  356. The current time will appear in the Time Out string gadget.  If the Time
  357. is satisfactory, you may continue.  If you wish to make changes you may
  358. do so by selecting the Time Out string gadget and make changes followed
  359. by {ENTER}.
  360.  
  361. TimeKeep-Dev does not allow time to be carried on over 24 hours.  For
  362. this reason, changing the information in the Date string will change the
  363. Date for both Time In and Time Out.
  364.  
  365.  
  366. QUITTING
  367. ========
  368.  
  369. If you wish to save any changes you have made, you should click on SAVE
  370. or SAVE & QUIT.
  371.  
  372. · Left-Click on the QUIT gadget.
  373.  
  374.  
  375. END OF TUTORIAL
  376. ===============
  377. For further information about the use of TimeKeep-Dev see the  Gadgets 
  378. section.
  379. ============================================================================
  380. Gadgets
  381. ----------------------------------------------------------------------------
  382. Gadgets
  383. -------
  384.  
  385. So Far:
  386. -------
  387.   These gadgets display the total hours and minutes spent on Projects and
  388.   Modules for the currently selected Project.  They are calculated as:
  389.  
  390.                   <TimeOut> - <TimeIn> + <CurrentValue>
  391.  
  392.   The following information may also be appear:
  393.  
  394.        ------       The amount has been altered, but not saved yet.
  395.  
  396.  
  397. Code:
  398. -----
  399.   This gadget displays the current Project Name Code.
  400.  
  401.   If the AutoProjectNameCode tooltype is activated, pressing 'HELP' within
  402.   this gadget will re-invoke the builtin feature.  This can be useful if
  403.   you accidentally change the contents of this gadget and are not
  404.   familiar with the method used to determine the Project Name Code.  If
  405.   AutoProjectNameCode is not activated, pressing 'HELP' will clear this
  406.   gadget.
  407.  
  408.  
  409. Cancel:
  410. -------
  411.   This gadget is active when TimeIn (and TimeOut) information is
  412.   displayed.  Selecting 'Cancel' will delete the TimeIn (and TimeOut)
  413.   information.
  414.  
  415. ============================================================================
  416. Project Name Codes
  417. ----------------------------------------------------------------------------
  418. Project Name Codes
  419. ------------------
  420.  
  421. Project Name Codes can be a maximum of 6 characters long.
  422.  
  423. TimeKeep-Dev has a built-in function to automatically create Project Name
  424. Codes.  At present, it simply combines the first letter of each word in
  425. the Project name.
  426.  
  427. If you have a method of creating Name Codes that you would like to see
  428. supported, contact the author.  See:  Locating The Author 
  429.  
  430. This feature can be enabled or disabled using the AutoProjectNameCode
  431. ToolType.
  432.  
  433.  
  434. Applicable Configuration Commands:
  435.  
  436.                             AutoProjectNameCode 
  437. ============================================================================
  438. Programming
  439. ----------------------------------------------------------------------------
  440. Programming
  441. -----------
  442.  
  443. If you write your own TimeKeep-Dev utility for any other software, please
  444. send a copy to the author for inclusion with this distribution.
  445. See:  Locating The Author 
  446.  
  447.  
  448. .time File Format
  449. -----------------
  450.  
  451. This is the format of the .time data file created by TimeKeep-Dev.
  452.  
  453. LINE 1:
  454.                    "<ProjectNameCode>","<ProjectName>"
  455.  
  456.   example:
  457.                         "TEST1","This is Test #1"
  458.  
  459.  
  460. LINE 2...n:
  461.  
  462.    "T","<Module>","<DateIn>","<TimeIn>","<TimeOut>",<Hours>,<Minutes>
  463.  
  464.   where:
  465.  
  466.   "T" = Time Information
  467.  
  468.      <Module>  = Module name
  469.      <DateIn>  = Time In date
  470.      <TimeIn>  = Time In time
  471.      <TimeOut> = Time Out time
  472.      <Hours>   = TimeOut - TimeIn (hours)
  473.      <Minutes> = TimeOut - TimeIn (minutess)
  474.  
  475.   examples:
  476.  
  477.          "T","Test Module","May 16","12:15 PM","1:00 PM", 0, 45
  478. ============================================================================
  479. Legalness
  480. ----------------------------------------------------------------------------
  481. Legalness
  482. ---------
  483.  
  484. TimeKeep-Dev is copyright ©1994-1995 by Scotware\Software.  With the
  485. exception of the ARexx utilities, the files included with this
  486. distribution may not be altered in any way.  TimeKeep-Dev is released as
  487. Shareware - You are required to pay a  Shareware  fee if you continue
  488. to use this software beyond a trial period of 10 days.
  489.  
  490. The software concept and design remain the property of the author,
  491. scott dhomas trenn and Scotware\Software.
  492.  
  493. Permission is granted for this program to appear in any public domain
  494. software archives.
  495.  
  496. Permission is granted for this program to appear on any commercial disks
  497. or CDROMs, provided that a single copy of the first product, containing
  498. this version of this progam, is sent to the author.
  499.  
  500. The author is in no way liable for any damage resulting from the use of
  501. this program.
  502. ============================================================================
  503. Future Enhancements
  504. ----------------------------------------------------------------------------
  505. Future Enhancements
  506. -------------------
  507.  
  508. -  Definable Project Code function
  509. -  Busy pointer
  510. -  Select InProgress button gadget
  511. -  Runnable from CLI
  512. -  and MORE...
  513. ============================================================================
  514. Known BUGS
  515. ----------------------------------------------------------------------------
  516. Known BUGS
  517. ----------
  518.  
  519. - In Progress counter is not completely working.
  520. ============================================================================
  521. Locating The Author
  522. ----------------------------------------------------------------------------
  523. Locating The Author
  524. -------------------
  525.  
  526. If you like this program and would like to register, reward me for my
  527. efforts, or for bug reports, program ideas, or questions, or just to tell
  528. me about where you live.
  529.  
  530. I can be contacted through INTERNET EMAIL at:
  531.  
  532.                               dhomas@unb.ca
  533.  
  534. Or by MAIL at:
  535.                             scott dhomas trenn
  536.                             Scotware\Software
  537.                            797 Mitchell Street
  538.                              Fredericton, NB
  539.                              CANADA  E3B 3S8
  540.  
  541.  
  542. Registered users may send me $5.00 (US) and a disk, for the latest
  543. version of this software.
  544.  
  545. Be sure to include the version number you are currently using, and the
  546. name of the program you want, so I do not send you a version you already
  547. have or a program you do not want.  The version number can be found in the
  548. titlebar, at the top of this documentation file, or by typing:
  549.  
  550.                           Version TimeKeep-Dev
  551.  
  552. at a shell prompt.  It looks similar to     94.Oct.16
  553.  
  554. When reporting bugs or errors generated when you run TimeKeep-Dev, please
  555. include any error messages given by TimeKeep-Dev and also the version
  556. number you are using.  This will aid me in tracking down the problem.
  557. Thank-you.
  558.  
  559. If you have an EMAIL address please include that with your letter.
  560. ============================================================================
  561. Thank Yous
  562. ----------------------------------------------------------------------------
  563. Thank Yous
  564. ----------
  565.  
  566. Thanks to the following people for beta-testing, suggestions, and bug
  567. reports:
  568.  
  569. - Doug Hornal       - Enumclaw, Washington    USA
  570.  
  571.                                                             - dhomas trenn
  572. ============================================================================
  573. New in this version
  574. ----------------------------------------------------------------------------
  575. New In This Version
  576. -------------------
  577.  
  578. - Modified ToolType parsing routine.  Old method would crash when used
  579.   with programs such as ToolManager.
  580.  
  581. - Added 'Module SoFar' to keep track of individual module amounts.
  582.  
  583. - Fixed a few bugs that were not really bugs but felt like they were.
  584.  
  585. - SoFar minutes now forced to 2 digits: 3 is now 03.
  586.  
  587. - Changed all MWB icon shadows from blue to dark grey.
  588. ============================================================================
  589. Previous versions
  590. ----------------------------------------------------------------------------
  591. New In Version 94.Nov.03
  592. ------------------------
  593.  
  594. - Fixed an Uneven Address Error which caused a GURU (#8000 0003) on
  595.   68000/68010 CPUs.
  596.  
  597. - Changed MWB icon shadow from blue to dark grey.
  598.  
  599. New In Version 94.Oct.18
  600. ------------------------
  601.  
  602. - Modified UnRegistered version to allow partial saving.  This should make
  603.   it easier to decide if you want to get the full registered version.
  604.  
  605. - Added 'Cancel' TimeIn/TimeOut gadget.
  606.  
  607. - Background color is set to the BackFillColor tooltype setting, for
  608.   (Un)Registered text.
  609.  
  610. New In Version 94.Oct.16
  611. ------------------------
  612.  
  613. - First Release
  614. ============================================================================
  615.